home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / apidev / jobrec.arc / QJOB.FMT
Text File  |  1989-08-09  |  8KB  |  198 lines
  1.  
  2.                Definition of Record Structure for print Queue Jobs
  3.                ---------------------------------------------------
  4.                              Revised March 31, l987
  5.  
  6.  
  7. This data applies to all queue jobs, not just print jobs.
  8.  
  9.      Fields are marked as follows:
  10.           Q -  Set up by thc queue management software and may not be changed.
  11.           C -  Set up by the client, ignored by the queue management software. 
  12.                May be changed by client with queue function calls.
  13.           U -  Set up by client, used by queue management software.  May be
  14.                changed by client with queue function calls.
  15.           M -  Set up by tbe queue management software but may be modified by
  16.                issuing queue function calls.
  17.  
  18.      Long and Word are in High-Low order.
  19.  
  20. Q:Byte         Client Station
  21.                     Connection number that put this job in the Queue.
  22.  
  23. Q:Byte         Client Task
  24.                     Task number that submitted the job.
  25.  
  26. Q:Long         Client ID Number
  27.                     User ID of user thst submitted job.
  28.  
  29. U:Long         Target Server ID Number
  30.                     Target server for job. If any server may service the job,
  31.                     use -1.
  32.  
  33. U:Byte[ 6]     Target Execution Time
  34.                     Time the Job should be executed.  Year, Month, Day, Hour.
  35.                     Minute, Second.  All 0xFF means as soon as possible.
  36.  
  37. Q:Byte[ 6]     Job Entry Time
  38.                     Time job was entered in queue. Same format as above.
  39.  
  40. Q:Word         Job Number
  41.                     Job number for this print job.
  42.  
  43. U:Word         Job Type
  44.                     This field will be used as the form number for print jobs.
  45.  
  46. M:Byte         Job Position
  47.                     Position in the queue of this job.
  48.  
  49. U:Byte         Job Control Flags
  50.                     80h: Set if job put on bold by operator.
  51.                     40h: Set if put on hold by user.
  52.                     20h: Set when you call CreateAQueueJob.  Cleared when you
  53.                          call CloseAndStartQueueJob.
  54.                     10h: Set if job may be restarted in the event of a server
  55.                          failure.
  56.                     08h: Set if job should started if user has not done
  57.                          CloseAndStartQueueJob and the users connection is
  58.                          terminated.
  59.  
  60. Q:Byte[14]     Job File Name
  61.                     File name created when CreateQueueJob was called.
  62.  
  63.  
  64.  
  65.  
  66.  
  67. Q:Byte[ 6]     Job File Handle
  68.                     File handle for file created when CreateQueueJob was called.
  69.  
  70. Q:Byte         Server Station
  71.                     Station number of server servicing the job.  This is
  72.                     undefined unless the job is currently being serviced.
  73.  
  74. Q:Byte         Server Task
  75.                     Task number of queue server servicing the task.
  76.  
  77. Q:Long         Server ID Number
  78.                     Server ID of server servicing the task.
  79.  
  80. C:Byte[ 50]    Job Description Text
  81.                     Description of the job.  This will usually be the name of
  82.                     the file being printed, but the user can change it.
  83.  
  84. C:Byte[132]    Client Record Area
  85.                     Special data chat is only defined for print jobs.
  86.  
  87.  
  88.  
  89.                         Definition of Client Record Area
  90.                         --------------------------------
  91.  
  92. This data applies only to print jobs.  All of these fields must be set up by the
  93. client and may be changed by the client with Queue Function Calls.
  94.  
  95. Byte           Client Record Area version number
  96.                     Current version is 0.
  97.  
  98. Byte           Tab Size
  99.                     Number of spaces that tabs will be expanded to. Minimum is
  100.                     0, maximum of 18.
  101.  
  102. Word           Number of copies.
  103.  
  104. Word           Control Flags.
  105.                     0080h: Set if banner should be printed
  106.                     0040h: Set if text stream. If set, tabs are expanded and the
  107.                            lines per page and characters per line fields are
  108.                            ignored.
  109.                     0008h: Set if form feeds should be suppressed.
  110.                     0004h: Print job if interrupted during cature process.
  111.  
  112. Word           Maximum Lines per Page. Default 60.
  113.  
  114. Word           Maximum Characters per Line. Default 132.
  115.  
  116. Byte[ 16]      Null terminated form name
  117.  
  118. Byte[ 6]       Reserved for future use.
  119.                     Should be set to zero.
  120.  
  121. Byte[ 13]      Banner Name Field
  122.                     Text to be printed in the first box on the banner.  This is
  123.                     usually the user name, but the user should be able to change
  124.                     it.
  125.  
  126. Byte[ 13]      Banner File Field
  127.                     Text to be printed in second box on banner.  This is
  128.                     currently used for the file name.  But the user should be
  129.                     able to change it.
  130.  
  131.  
  132.  
  133. Byte[ 14]      Header File Name
  134.                     File name printed in header of banner.
  135.  
  136. Byte[ 80]      Directory Path
  137.                     Full path name of the file to be printed.
  138.  
  139.  
  140.  
  141.                               Format of New Banner
  142.                               --------------------
  143.  
  144. ********************************************************************************
  145. *  User Name: {From Client ID}{Station}     Queue:  {File Server}{Queue Name}  *
  146. *  File Name: {From Header File Name}       Server: {Print Server}             *
  147. *  {Directory of the file being printed}                                       *
  148. *  {Date submitted}                         {Time submitted}                   *
  149. *  {Job description text}                                                      *
  150. ********************************************************************************
  151. *                                                                              *
  152. *                                                                              *
  153. *                                                                              *
  154. *                                                                              *
  155. *                                                                              *
  156. *                     {Banner Name Field in large letters}                     *
  157. *                                                                              *
  158. *                                                                              *
  159. *                                                                              *
  160. *                                                                              *
  161. *                                                                              *
  162. ********************************************************************************
  163. *                                                                              *
  164. *                                                                              *
  165. *                                                                              *
  166. *                                                                              *
  167. *                     {Banner File Field in large letters}                     *
  168. *                                                                              *
  169. *                                                                              *
  170. *                                                                              *
  171. *                                                                              *
  172. ********************************************************************************
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.